Azure Maps Route Service (preview:2024-05-01)

2025/10/15 • 7 deleted methods

Route_PostRouteDirections (removed)
Description :  The `Route Directions` API is an HTTP `POST` request that returns the ideal route between an origin and destination for automobile (driving), commercial trucks and walking routes. The route passes through a series of waypoints if specified. A waypoint is a geographical location defined by longitude and latitude that is used for navigational purposes. The route considers factors such as current traffic and the typical road speeds on the requested day of the week and time of day. The API returns the distance, estimated travel time, and a representation of the route geometry. More routing information such as an optimized waypoint order or turn by turn instructions is also available, depending on the parameters used. The Route Directions considers local laws, vehicle dimensions, cargo type, max speed, bridge and tunnel heights to calculate the truck specific routes and avoid complex maneuvers and difficult roads. Not all trucks can travel the same routes as other vehicles due to certain restrictions based on the vehicle profile or cargo type. For example, highways often have separate speed limits for trucks, some roads don't allow trucks with flammable or hazardous materials, and there can be height and weight restriction on bridges. Up to 25 waypoints and 10 viaWaypoints between any two waypoints is supported for driving and walking routes. Each set of waypoints creates a separate route Leg. ViaWaypoints define the route path and can be used for route creation through specific locations, but they don't create route Legs. Truck routes support up to 150 waypoints but don't support viaWaypoints. For information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2). >[!Important] >By using this feature, you agree to the preview legal terms. For more information, see [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/).
Reference :  Link ¶

⚼ Request

POST:  /route/directions
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
Accept-Language:
{
Description: Language in which routing results should be returned. For more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages). ,
Required: False ,
}
string ,
routeDirectionsRequest:
{
Description: Request body of RouteDirections API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: Driving and walking routes are defined by a set of waypoints(stops) and viaWaypoints (intermediate locations that the route must pass through). You can have a maximum of 25 waypoints, and a maximum of 10 viaWaypoints between each set of waypoints. Truck route supports up to 150 waypoints and viaWaypoints are not supported. A route must have a minimum of 2 waypoints and the start and end points of the route cannot be viaWaypoints. Both waypoint and viaWaypoint locations must be specified as a valid GeoJSON Point feature object along with pointIndex that specifies the order of the locations. For more information on the GeoJSON format, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
properties:
{
Description: Specifies the properties of a Waypoint which is a specific location or point along a route or trip that serves as a reference or stopping point. ,
Required: True ,
}
{
pointIndex:
{
Description: Identify and order the sequence of waypoints in the route. The default value is the `index value` of a features array. ,
Format: int64 ,
Required: False ,
}
integer ,
pointType:
{
Description: Waypoint type on the route. It can be a stop or an intermediate location that the route must pass through. ,
Enum:
{
waypoint: A waypoint is a specific location or point along a route or trip that serves as a reference or stopping point. ,
viaWaypoint: A viaWaypoint is a specific waypoint that must be passed through or visited along a route or trip. `Note`: Only supported for driving travelMode. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
travelMode:
{
Description: The mode of travel for the requested route. If not defined, the default value is "driving" that returns the route optimized for cars. `Note`: For truck travelMode, the requested truck route may not be available for the entire route. Where the truck route is not available for a particular section, the travelMode element of the response for that section will be "other". Example: "travelMode":"driving" ,
Enum:
{
driving: The returned routes are optimized for cars. ,
truck: The returned routes are optimized for large size trucks based on the vehicle specification. ,
walking: The returned routes are optimized for pedestrians, including the use of sidewalks. ,
}
,
Required: False ,
}
enum ,
departAt:
{
Description: The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `departAt` value must be in the future in the date-time format or now value to set it to the current time. Examples: "departAt": "2023-06-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
arriveAt:
{
Description: The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `arriveAt` value must be in the future. The `arriveAt` parameter cannot be used in conjunction with `departAt`. Example: "arriveAt": "2023-06-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
optimizeRoute:
{
Description: Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information. Example: "optimizeRoute":"shortest" ,
Enum:
{
shortest: The route is calculated to minimize the distance. Traffic information is not used. ,
fastestWithoutTraffic: Finds the fastest route, without factoring in traffic information. ,
fastestAvoidClosureWithoutTraffic: The route is calculated to minimize the time and avoid road closures. No traffic information except for road closures is used in the calculation. `Note`: Only supported for driving travelMode. ,
fastestWithTraffic: The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode. ,
}
,
Required: False ,
}
enum ,
optimizeWaypointOrder:
{
Description: Re-order the route waypoints using a fast heuristic algorithm to reduce the route cost specified with the optimize parameter. The origin and destination are excluded from the optimized waypoint and their position is considered fixed. Acceptable values are true or false. `Note`: Only supported for truck travelMode. ,
Required: False ,
}
boolean ,
avoid:
{
Description: Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. Example: "avoid": ["limitedAccessHighways", "tolls"] ,
Required: False ,
}
[
string ,
]
,
routeOutputOptions:
{
Description: Include the desired route information from the response. By default, the itinerary is included in the response. Supports multiple values such as "routeOutputOptions": ["routePath", "regionTravelSummary"] ,
Required: False ,
}
[
string ,
]
,
maxRouteCount:
{
Description: The maximum number of routes to return. Available for the driving and truck travel modes. For driving routes, this parameter supports routes with up to two waypoints in addition to the origin and destination and avoid parameter must not be set. Default: "maxRouteCount":1 Minimum: "maxRouteCount":1 Maximum: "maxRouteCount":3 ,
Format: int64 ,
Required: False ,
}
integer ,
heading:
{
Description: The initial directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359 ,
Format: int64 ,
Required: False ,
}
integer ,
vehicleSpec:
{
Description: Specifies the vehicle attributes such as size, weight, max speed, type of cargo for truck routing only. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications. `Note`: Only supported for truck travelMode ,
Required: False ,
}
{
isVehicleCommercial:
{
Description: Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. ,
Required: False ,
}
boolean ,
length:
{
Description: Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Weight of the vehicle in kilograms. A value of 0 means that weight restrictions are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSpeed:
{
Description: Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. ,
Format: int64 ,
Required: False ,
}
integer ,
axleWeight:
{
Description: Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
axleCount:
{
Description: Number of axles on the vehicle. A value of 0 means that axle restrictions are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
loadType:
{
Description: Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: This object is returned from a successful call. ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostRouteDirectionsBatch (removed)
Description :  The `Route Directions Batch` API is an HTTP `POST` request that sends batches of up to **100** queries in a single call to the [Route Directions](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview) API. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for additional details. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/route/directions:batch?api-version=2023-10-01-preview ``` ### POST Body for Batch Request To send the _directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _directions_ queries: ``` { "batchItems": [ { "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94", "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "coordinates": [ -122.3368, 47.614988 ], "type": "Point" }, "properties": { "pointIndex": 0, "pointType": "waypoint" } }, { "type": "Feature", "geometry": { "coordinates": [ -122.316067, 47.606356 ], "type": "Point" }, "properties": { "pointIndex": 1, "pointType": "waypoint" } } ], "optimizeRoute": "fastestWithoutTraffic", "routeOutputOptions": [ "routeSummary" ], "maxRouteCount": 3, "travelMode": "driving" }, { "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a", "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "coordinates": [ -122.3368, 47.614988 ], "type": "Point" }, "properties": { "pointIndex": 0, "pointType": "waypoint" } }, { "type": "Feature", "geometry": { "coordinates": [ -122.316067, 47.606356 ], "type": "Point" }, "properties": { "pointIndex": 1, "pointType": "waypoint" } } ], "optimizeRoute": "shortest", "routeOutputOptions": [ "routeSummary" ], "maxRouteCount": 2, "travelMode": "driving" } ] } ``` A _directions_ batchItem object can accept any of the supported _directions_ [Request body](/rest/api/maps/route/post-directions?view=rest-maps-2023-10-01-preview#request-body) The batch should contain at least **1** query. ### Batch Response Model The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types: - [`DirectionsResponse`](/rest/api/maps/route/post-directions#response) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
Reference :  Link ¶

⚼ Request

POST:  /route/directions:batch
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
routeDirectionsBatchRequest:
{
Description: The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries to process. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (207)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_SubmitDirectionsAsynchronousBatch (removed)
Description :  The Directions Asynchronous Batch API is designed for processing large volumes of route direction queries asynchronously. This API is optimized for handling high-volume batch requests without the need for immediate response times, making it ideal for extensive geocoding operations. After submitting your batch request, the service processes the queries in the background. You can check the status of the request periodically and retrieve the results once they are available. This approach is beneficial for applications that can accommodate longer processing times and do not require instant responses. >[!Important] >By using this feature, you agree to the preview legal terms. For more information, see [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/). ### Submitting an Asynchronous Batch Request To submit a request, you must provide the following: - **`inputBlobUrl`**: A URL pointing to a blob storage that contains your batch of geocoding queries. The format of the data should be consistent with that used for the synchronous batch version. - **`outputStorageUrl`**: The destination URL where the batch results will be stored upon completion. - **`msiClientId`** (optional): The Client ID of a user-assigned managed identity. This is used for authentication and authorization of both `inputBlobUrl` and `outputStorageUrl`. If the managed identity is system-assigned, this field can be left null. The response header `Operation-Location` returns a URL with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com`. To ensure that the endpoint returned in the `Operation-Location` header is the same as the submit job endpoint, using the geography endpoint is suggested.
Reference :  Link ¶

⚼ Request

POST:  /route/directions:asyncBatch
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Language in which routing results should be returned. For more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages). ,
Required: False ,
}
string ,
directionsAsyncBatchRequestBody:
{
Description: The request body for directions asynchronous batch request. ,
Required: True ,
}
{
inputBlobUrl:
{
Description: The URL to the input blob containing the batch of queries. This should be a valid URL pointing to a blob of an Azure Storage Account ,
Format: uri ,
Required: True ,
}
string ,
outputStorageUrl:
{
Description: The URL that points to a blob storage where the batch results will be stored. ,
Format: uri ,
Required: True ,
}
string ,
msiClientId:
{
Description: Client ID of a user-assigned managed identity. This is used for authentication and authorization purposes. If the managed identity is system-assigned, this field can be null. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: URL to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostSnapToRoads (removed)
Description :  **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Snap to Roads API accepts GPS point data, represented as latitude and longitude coordinates, and generates a route that aligns with existing roadways on a map. This process, known as "snapping to roads," produces a series of objects that trace a path closely following the road network. The resulting data includes road names and their respective speed limits, pertinent to the traversed segments. Moreover, the Snap to Roads API offers an interpolation feature, which refines the GPS points to create a smoother route that adheres to the road's geometry. This functionality is especially beneficial for asset tracking and enhancing data visualization in mapping applications. For information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2). >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.
Reference :  Link ¶

⚼ Request

POST:  /route/snapToRoads
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
Accept-Language:
{
Description: Language in which routing results should be returned. For more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages). ,
Required: False ,
}
string ,
snapToRoadsRequest:
{
Description: Request body of SnapToRoads API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: A set of points to snap to roads. You can have a maximum of 100 points. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
properties:
{
Description: Feature properties. ,
Required: True ,
}
object ,
}
,
]
,
interpolate:
{
Description: Specify whether to insert additional points between the snapped points to complete the full route path ,
Required: False ,
}
boolean ,
includeSpeedLimit:
{
Description: Specify whether to include speed limit information for the snapped points. The unit is in kilometers per hour. `Note`: Only supported for driving travelMode ,
Required: False ,
}
boolean ,
travelMode:
{
Description: Specify the travel mode for snapping the coordinates. If unspecified, the default mode is "driving", which optimizes the snapped coordinates for driving routes. ,
Enum:
{
driving: driving ,
walking: walking. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: `GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostSnapToRoadsBatch (removed)
Description :  **SnapToRoads Batch API** **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Snap To Roads Batch API sends batches of up to **100** queries as a single call to the [Snap To Roads API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-05-01-preview). >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/route/snapToRoads:batch?api-version=2024-05-01-preview ``` ### POST Body for Batch Request To send the _snap to roads_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _snap to roads_ queries: ``` { "batchItems": [ { "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "coordinates": [ -122.122353, 47.672662 ], "type": "Point" }, "properties": { } }, { "type": "Feature", "geometry": { "coordinates": [ -122.132452, 47.644234 ], "type": "Point" }, "properties": { } } ], "interpolate": true, "includeSpeedLimit": true, "travelMode": "driving" }, { "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "coordinates": [ -122.33669, 47.590849 ], "type": "Point" }, "properties": { "pointIndex": 0 } }, { "type": "Feature", "geometry": { "coordinates": [ 122.34509, 47.610524 ], "type": "Point" }, "properties": { "pointIndex": 1 } } ], "interpolate": false, "includeSpeedLimit": false, "travelMode": "driving" } ] } ``` A _snap to roads_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-05-01-preview#request-body) The batch should contain at least **1** query. ### Batch Response Model The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types: - [`SnapToRoadsResponse`](/rest/api/maps/route/post-snap-to-roads#response) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
Reference :  Link ¶

⚼ Request

POST:  /route/snapToRoads:batch
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
snapToRoadsBatchRequest:
{
Description: The list of Snap To Roads queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries to process. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (207)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostRouteRange (removed)
Description :  **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). This service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone. For information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2). >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.
Reference :  Link ¶

⚼ Request

POST:  /route/range
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
Accept-Language:
{
Description: Language in which routing results should be returned. For more information, see [Localization support in Azure Maps](https://learn.microsoft.com/en-us/azure/azure-maps/supported-languages#routing-v2-services-preview-supported-languages). ,
Required: False ,
}
string ,
routeRangeRequest:
{
Description: Request body of RouteRange API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
properties:
{
Description: Specifies the properties of Route Range ,
Required: True ,
}
{
departAt:
{
Description: The date and time of departure from the origin point formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The departAt value must be in the future in the date-time format or now value to set it to the current time. Examples: "departAt": "2023-06-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
isSimplifiedPolygon:
{
Description: Return simplified polygons for the route range. ,
Required: False ,
}
boolean ,
optimizeRoute:
{
Description: Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information. Example: "optimizeRoute":"shortest" ,
Enum:
{
shortest: The route is calculated to minimize the distance. Traffic information is not used. ,
fastestWithoutTraffic: Finds the fastest route, without factoring in traffic information. ,
fastestWithTraffic: The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode. ,
thrillingWithTraffic: The route is calculated to provide a thrilling driving experience using current traffic information. ,
thrillingWithoutTraffic: The route is calculated to provide a thrilling driving experience without using current traffic information. ,
}
,
Required: False ,
}
enum ,
avoid:
{
Description: Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. Example: "avoid": ["limitedAccessHighways", "tolls"] ,
Required: False ,
}
[
string ,
]
,
vehicleSpec:
{
Description: Vehicle attributes are specified inside of a vehicleSpec. Different regions may have different definitions for the truck classification and types, e.g., light truck, medium truck, heavy truck, etc. To get the most accurate results of the route restrictions based on the truck specs, specify the vehicle attributes. `Note`: Only supported for truck travelMode. ,
Required: False ,
}
{
isVehicleCommercial:
{
Description: Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. ,
Required: False ,
}
boolean ,
length:
{
Description: Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
width:
{
Description: Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
height:
{
Description: Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Weight of the vehicle in kilograms. A value of 0 means that weight restrictions are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSpeed:
{
Description: Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. ,
Format: int64 ,
Required: False ,
}
integer ,
axleWeight:
{
Description: Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
axleCount:
{
Description: Number of axles on the vehicle. A value of 0 means that axle restrictions are not considered. ,
Format: int64 ,
Required: False ,
}
integer ,
loadType:
{
Description: Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType supports multiple values in a request. ,
Required: False ,
}
[
string ,
]
,
}
,
distanceBudgetInMeters :
{
Description: The distance budget refers to the maximum number of meters one can travel without going over the set limit. ,
Required: False ,
}
number ,
timeBudgetInSec:
{
Description: The time budget represents the maximum number of seconds available for travel, defining how far one can go within this time constraint. ,
Required: False ,
}
number ,
thrilling:
{
Description: The thrilling object is used to describe a route with two main characteristics: windingness and hilliness and is used when optimizedRoute is thrilling mode. ,
Required: False ,
}
{
windingness:
{
Description: Specify the windingness of the route. If unspecified, the default mode is "normal". ,
Enum:
{
normal: normal ,
low: low ,
high: high ,
}
,
Required: False ,
}
enum ,
hilliness:
{
Description: Specify the hilliness of the route. If unspecified, the default mode is "normal". ,
Enum:
{
normal: normal ,
low: low ,
high: high ,
}
,
Required: False ,
}
enum ,
}
,
travelMode:
{
Description: Specify the travel mode. If unspecified, the default mode is "driving". ,
Enum:
{
driving: driving ,
truck: truck. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: `GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostRouteRangeBatch (removed)
Description :  **Route Range Batch API** **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Route Range Batch API sends batches of up to **100** queries as a single call to the [Route Range API](https://learn.microsoft.com/en-us/rest/api/maps/route/post-route-range?view=rest-maps-2024-05-01-preview). >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/route/range:batch?api-version=2024-05-01-preview ``` ### POST Body for Batch Request To send the _route range_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _route_range_ queries: ``` { "batchItems": [ { "type": "Feature", "geometry": { "type": "Point", "coordinates": [ 5.86605, 50.9745 ] }, "properties": { "timeBudgetInSec": 6000 } }, { "type": "Feature", "geometry": { "type": "Point", "coordinates": [ -122.201669, 47.615076 ] }, "properties": { "timeBudgetInSec": 2000 } } ] } ``` A _route range_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-05-01-preview#request-body) The batch should contain at least **1** query. ### Batch Response Model The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types: - [`RouteRangeResponse`](/rest/api/maps/route/post-route-range#response) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
Reference :  Link ¶

⚼ Request

POST:  /route/range:batch
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
routeRangeBatchRequest:
{
Description: The list of route directions queries/requests to process. The list can contain a max of 100 queries for sync version and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries to process. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (207)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}